home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / astr201.zip / ASTR.DOC < prev    next >
Text File  |  1991-02-26  |  7KB  |  186 lines
  1.                                Documentation for
  2.                             ANSISTRIP and ANSIVIEW
  3.                                  Version 2.01
  4.                                by Duane Paulson
  5.  
  6.  
  7.   Southern California Residents: You may, if you wish, post a message
  8.                  to DUANE PAULSON on the Main Board of
  9.                  THE KANDY SHACK BBS (714-636-2667)
  10.                  Garden Grove CA 1200/2400/9600/14400
  11.                  V.32bis and HST. Sysop: Mike
  12.                  Bernstein, and a great one he is, too.
  13.   Reach Out America Subscribers: Please see above
  14.               GEnie: D.PAULSON
  15.              CompuServe: 70671,666
  16.  
  17.  
  18.                        CONTENTS
  19.  
  20.         INTRODUCTION..........................Page 2
  21.         ANSISTRIP Strip Utility...............Page 3
  22.         ANSIVIEW File Viewer..................Page 4
  23.         Using ANSISTRIP and ANSIVIEW
  24.          with PRO-YAM or ZCOMM................Page 5
  25.  
  26. Professional-YAM and ZCOMM are trademarks of Omen Technology, Inc., with which
  27.  the author of this program has no connection.
  28.  
  29.  
  30.  
  31. ANSISTRIP Version 2.00 Documentation                     Page 2
  32.  
  33. I originally released ANSISTRP.EXE on 12/23/90. It removed ANSI screen control
  34. codes from a text file, and displayed the resulting text to the screen at the
  35. same time. I was not really satisfied with this arrangement. The control code
  36. strip function processed characters one at a time, making it not fast enough,
  37. and you couldn't stop the scrolling of text on the screen, making that function
  38. not accessible enough.
  39.  
  40. I have resolved these problems by breaking ANSISTRP into two pieces. ANSISTRIP
  41. will strip ANSI control codes from text files very rapidly, and ANSIVIEW will
  42. display text files containing ANSI screen control codes at an adjustable scroll
  43. rate, with a scroll pause feature, and an instant exit feature.
  44.  
  45. In addition, I have changed the way filenames are input in the utilities,
  46. replacing the in-program prompt feature with a command line parameter interface.
  47. ZCOMM and PRO-YAM users, in particular, can use this feature to good effect
  48. when tying these utilities to a function key in order to view or convert their
  49. customary capture file.
  50.  
  51.  
  52.                          80286 Protected Mode Support
  53.  
  54. This version is also able to support protected mode with systems using 80286
  55. or newer chips. The 286 versions ANSISTRIP and ANSIVIEW execute noticeably
  56. faster then the 8088-8086 default version.
  57.  
  58.  
  59.  
  60.  
  61. ANSISTRIP Version 2.00 Documentation                     Page 3
  62.  
  63.  
  64.                                    ANSISTRIP
  65.                   ANSI COMPUTER SCREEN CONTROL CODE STRIPPER
  66.                            ASTR.EXE and ASTR286.EXE
  67.  
  68.  
  69. FORMAT:
  70.         ASTR INPUT_FILENAME OUTPUT_FILENAME
  71.          (or)
  72.         ASTR286 INPUT_FILENAME OUTPUT_FILENAME
  73.  
  74. File names for the input file and output file must be specified on the command
  75. line. The filenames may include a drive and/or path specification. The input
  76. file must not be the same as the output file. ANSISTRIP needs two files open:
  77. one to read from, and one to write to.
  78.  
  79. ANSISTRIP assigns each of these files a large I/O buffer, and starts processing
  80. them a line at a time. The processing moves quickly, thanks to an optimized
  81. ANSI strip strategy. When ANSISTRIP is done, you will have a text file that can
  82. be viewed with an ASCII file viewer. You won't have the bothersome ANSI codes
  83. cluttering up the file, and making the text difficult to read.
  84.  
  85. Note that stripping ANSI sequences is no guarantee that a text file will become
  86. readable. If ANSI is used to move the cursor around, as on a BBS welcome
  87. screen, you will be left with a jumble of characters over by the left margin.
  88.  
  89. At places where ANSI is used just to change colors, as in file lists, etc.,
  90. the ANSI escapes will be removed, making the text readable when using a file
  91. viewer that bypasses the ANSI driver.
  92.  
  93.  
  94.  
  95.  
  96.  
  97. ANSISTRIP Version 2.00 Documentation                     Page 4
  98.  
  99.  
  100.                                    ANSIVIEW
  101.                         PAUSABLE SLOW-SCROLLING VIEWER
  102.                              FOR FILES CONTAINING
  103.                       ANSI COMPUTER SCREEN CONTROL CODES
  104.  
  105.  
  106. FORMAT:
  107.         AVIEW FILENAME
  108.          (or)
  109.         AVIEW286 FILENAME
  110.  
  111. Filename must be specified, and is, or course, the file to view. You may
  112. include a drive and/or path specification as part of the filename.
  113.  
  114. The file will be displayed in slow-scrolling ANSI format. What this means is
  115. that a pause will be inserted in processing after each character is written
  116. to the screen. This is the only way I could come up with to control the display
  117. of a file containing ANSI codes, since the cursor may jump around, and the
  118. screen may be cleared periodically by the ANSI codes.
  119.  
  120. The following keys are active during the scroll:
  121.  
  122.     <SPACEBAR> Pressing the spacebar temporarily suspends scrolling of the
  123.            display. Press any key to continue.
  124.  
  125.     <ESC>       Pressing the Esc key will immediately terminate the program.
  126.            The exit message will be displayed on the line below the
  127.            line where the cursor is currently located.
  128.  
  129.     <F>       Pressing the F key (The one on the typewriter keyboard, not
  130.            a function key) will speed up the scroll rate. The delay
  131.             rate is processor-dependent, and so this key will have a
  132.            different effect on different speed machines.
  133.  
  134.     <S>       Pressing the S key slows down the scroll rate.
  135.  
  136.  
  137.  
  138. ANSISTRIP Version 2.00 Documentation                     Page 5
  139.  
  140.  
  141.                        USING ANSISTRIP AND ANSIVIEW WITH
  142.                                PRO-YAM OR ZCOMM
  143.  
  144. ANSISTRIP and ANSIVIEW can be used to review your on-line sessions just as they
  145. occurred, in full, glorious, color, and with ANSI animation effects.
  146.  
  147. To do this, you'll have to get into your default PHONES file, and remove the
  148. -s parameter from your create capture file entry. The -s parameter prevents
  149. control codes from being written to your capture file. You can now use
  150. AVIEW[286].EXE from within PRO-YAM or ZCOMM to review your color capture file.
  151.  
  152. You MUST, however, close your capture file before attempting to view it. This
  153. is important.
  154.  
  155. While it is possible to run ANSISTRIP and ANSIVIEW from the PRO-YAM or ZCOMM
  156. command line, it is advisable to use the function keys to make sure certain
  157. key tasks are performed each time you use ANSISTRIP or ANSIVIEW.
  158.  
  159. Here are some sample entries. I use ZCOMM, and have named my default capture
  160. file ZCOMM.CAP. This file is automatically created each time I start ZCOMM, so
  161. that I can have a record of my session, in case I need to look back at
  162. something. I've tied the routines to the F11 key:
  163.  
  164.     open -y zcomm.cap    :In program initialization. Open and overwrite.
  165.  
  166.     set f11 "@gosub ansiview"        :F11 views capture file.
  167.     set fa11 "@gosub ansistrip"        :Alt-F11 strips cap file ANSI.
  168.  
  169.  
  170. ansiview:
  171.     close zcomm.cap                :Close default cap file.
  172.     !aview zcomm.cap            :View it.
  173.     create -+ zcomm.cap            :Reopen in append mode.
  174.     return
  175.  
  176. ansistrip:
  177.     close zcomm.cap                :Close default cap file.
  178.     !astr zcomm.cap zcomm.asc        :Strip and save it in zcomm.asc.
  179.     create -y zcomm.cap            :Reopen in overwrite mode.
  180.     return
  181.  
  182.  
  183. It is important to note that, in the above example, each time F11 is hit,
  184. ZCOMM.ASC is overwritten. Therefore, you should only hit this key at the end
  185. of your session, to avoid losing your material.
  186.